Revise the Yar extension documentation - #5804
Merged
Merged
Conversation
Rewrite the entire Yar reference against the current extension source: - Document all nine YAR_OPT_* client options and their effect on call behaviour, including the previously undocumented resolve, proxy, token and provider options - Add the missing Yar_Client::getOpt() method page - Describe the exception hierarchy accurately: which transport, protocol and packager failures raise which exception class, and how errors surface as Yar_Client_Exception codes - Rewrite the ini page with correct defaults and ranges, the concurrent client examples with realistic usage, and the packager section with msgpack support - Modernize markup: simpara instead of para, exceptionname for exception classes, union return types, and cross-link related pages via See Also
This was referenced Aug 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrites the entire Yar extension documentation against the current source of the extension, fixing outdated and incomplete information that had accumulated.
Changes
YAR_OPT_*client options and their effect on call behaviour, including the previously undocumented resolve, proxy, token and provider optionsYar_Client::getOpt()method pageYar_Client_Exceptioncodessimparainstead ofpara,exceptionnamefor exception classes, union return types, and cross-link related pages via See AlsoValidation
doc-base/configure.phpbuild passesphd -f phprenders the whole manual cleanlydocbook-csreports zero new violations introduced by this change